home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / tcl / dist6.3 / doc / GetInt.man < prev    next >
Encoding:
Text File  |  1992-04-30  |  6.7 KB  |  261 lines
  1. '\"
  2. '\" Copyright 1989 Regents of the University of California
  3. '\" Permission to use, copy, modify, and distribute this
  4. '\" documentation for any purpose and without fee is hereby
  5. '\" granted, provided that this notice appears in all copies.
  6. '\" The University of California makes no representations about
  7. '\" the suitability of this material for any purpose.  It is
  8. '\" provided "as is" without express or implied warranty.
  9. '\" 
  10. '\" $Header: /user6/ouster/tcl/man/RCS/GetInt.man,v 1.5 92/03/28 14:21:11 ouster Exp $ SPRITE (Berkeley)
  11. '\" 
  12. .\" The definitions below are for supplemental macros used in Sprite
  13. .\" manual entries.
  14. .\"
  15. .\" .HS name section [date [version]]
  16. .\"    Replacement for .TH in other man pages.  See below for valid
  17. .\"    section names.
  18. .\"
  19. .\" .AP type name in/out [indent]
  20. .\"    Start paragraph describing an argument to a library procedure.
  21. .\"    type is type of argument (int, etc.), in/out is either "in", "out",
  22. .\"    or "in/out" to describe whether procedure reads or modifies arg,
  23. .\"    and indent is equivalent to second arg of .IP (shouldn't ever be
  24. .\"    needed;  use .AS below instead)
  25. .\"
  26. .\" .AS [type [name]]
  27. .\"    Give maximum sizes of arguments for setting tab stops.  Type and
  28. .\"    name are examples of largest possible arguments that will be passed
  29. .\"    to .AP later.  If args are omitted, default tab stops are used.
  30. .\"
  31. .\" .BS
  32. .\"    Start box enclosure.  From here until next .BE, everything will be
  33. .\"    enclosed in one large box.
  34. .\"
  35. .\" .BE
  36. .\"    End of box enclosure.
  37. .\"
  38. .\" .VS
  39. .\"    Begin vertical sidebar, for use in marking newly-changed parts
  40. .\"    of man pages.
  41. .\"
  42. .\" .VE
  43. .\"    End of vertical sidebar.
  44. .\"
  45. .\" .DS
  46. .\"    Begin an indented unfilled display.
  47. .\"
  48. .\" .DE
  49. .\"    End of indented unfilled display.
  50. .\"
  51. '    # Heading for Sprite man pages
  52. .de HS
  53. .if '\\$2'cmds'       .TH \\$1 1 \\$3 \\$4
  54. .if '\\$2'lib'        .TH \\$1 3 \\$3 \\$4
  55. .if '\\$2'tcl'        .TH \\$1 3 \\$3 \\$4
  56. .if '\\$2'tk'         .TH \\$1 3 \\$3 \\$4
  57. .if t .wh -1.3i ^B
  58. .nr ^l \\n(.l
  59. .ad b
  60. ..
  61. '    # Start an argument description
  62. .de AP
  63. .ie !"\\$4"" .TP \\$4
  64. .el \{\
  65. .   ie !"\\$2"" .TP \\n()Cu
  66. .   el          .TP 15
  67. .\}
  68. .ie !"\\$3"" \{\
  69. .ta \\n()Au \\n()Bu
  70. \&\\$1    \\fI\\$2\\fP    (\\$3)
  71. .\".b
  72. .\}
  73. .el \{\
  74. .br
  75. .ie !"\\$2"" \{\
  76. \&\\$1    \\fI\\$2\\fP
  77. .\}
  78. .el \{\
  79. \&\\fI\\$1\\fP
  80. .\}
  81. .\}
  82. ..
  83. '    # define tabbing values for .AP
  84. .de AS
  85. .nr )A 10n
  86. .if !"\\$1"" .nr )A \\w'\\$1'u+3n
  87. .nr )B \\n()Au+15n
  88. .\"
  89. .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
  90. .nr )C \\n()Bu+\\w'(in/out)'u+2n
  91. ..
  92. '    # BS - start boxed text
  93. '    # ^y = starting y location
  94. '    # ^b = 1
  95. .de BS
  96. .br
  97. .mk ^y
  98. .nr ^b 1u
  99. .if n .nf
  100. .if n .ti 0
  101. .if n \l'\\n(.lu\(ul'
  102. .if n .fi
  103. ..
  104. '    # BE - end boxed text (draw box now)
  105. .de BE
  106. .nf
  107. .ti 0
  108. .mk ^t
  109. .ie n \l'\\n(^lu\(ul'
  110. .el \{\
  111. .\"    Draw four-sided box normally, but don't draw top of
  112. .\"    box if the box started on an earlier page.
  113. .ie !\\n(^b-1 \{\
  114. \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  115. .\}
  116. .el \}\
  117. \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
  118. .\}
  119. .\}
  120. .fi
  121. .br
  122. .nr ^b 0
  123. ..
  124. '    # VS - start vertical sidebar
  125. '    # ^Y = starting y location
  126. '    # ^v = 1 (for troff;  for nroff this doesn't matter)
  127. .de VS
  128. .mk ^Y
  129. .ie n 'mc \s12\(br\s0
  130. .el .nr ^v 1u
  131. ..
  132. '    # VE - end of vertical sidebar
  133. .de VE
  134. .ie n 'mc
  135. .el \{\
  136. .ev 2
  137. .nf
  138. .ti 0
  139. .mk ^t
  140. \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
  141. .sp -1
  142. .fi
  143. .ev
  144. .\}
  145. .nr ^v 0
  146. ..
  147. '    # Special macro to handle page bottom:  finish off current
  148. '    # box/sidebar if in box/sidebar mode, then invoked standard
  149. '    # page bottom macro.
  150. .de ^B
  151. .ev 2
  152. 'ti 0
  153. 'nf
  154. .mk ^t
  155. .if \\n(^b \{\
  156. .\"    Draw three-sided box if this is the box's first page,
  157. .\"    draw two sides but no top otherwise.
  158. .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  159. .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
  160. .\}
  161. .if \\n(^v \{\
  162. .nr ^x \\n(^tu+1v-\\n(^Yu
  163. \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
  164. .\}
  165. .bp
  166. 'fi
  167. .ev
  168. .if \\n(^b \{\
  169. .mk ^y
  170. .nr ^b 2
  171. .\}
  172. .if \\n(^v \{\
  173. .mk ^Y
  174. .\}
  175. ..
  176. '    # DS - begin display
  177. .de DS
  178. .RS
  179. .nf
  180. .sp
  181. ..
  182. '    # DE - end display
  183. .de DE
  184. .fi
  185. .RE
  186. .sp .5
  187. ..
  188. .HS Tcl_GetInt tcl
  189. .BS
  190. .SH NAME
  191. Tcl_GetInt, Tcl_GetDouble, Tcl_GetBoolean \- convert from string to integer, double, or boolean
  192. .SH SYNOPSIS
  193. .nf
  194. \fB#include <tcl.h>\fR
  195. .sp
  196. int
  197. \fBTcl_GetInt\fR(\fIinterp, string, intPtr\fR)
  198. .sp
  199. int
  200. \fBTcl_GetDouble\fR(\fIinterp, string, doublePtr\fR)
  201. .sp
  202. int
  203. \fBTcl_GetBoolean\fR(\fIinterp, string, boolPtr\fR)
  204. .SH ARGUMENTS
  205. .AS Tcl_Interp *doublePtr
  206. .AP Tcl_Interp *interp in
  207. Interpreter to use for error reporting.
  208. .AP char *string in
  209. Textual value to be converted.
  210. .AP int *intPtr out
  211. Points to place to store integer value converted from \fIstring\fR.
  212. .AP double *doublePtr out
  213. Points to place to store double-precision floating-point
  214. value converted from \fIstring\fR.
  215. .AP int *boolPtr out
  216. Points to place to store boolean value (0 or 1) converted from \fIstring\fR.
  217. .BE
  218.  
  219. .SH DESCRIPTION
  220. .PP
  221. These procedures convert from strings to integers or double-precision
  222. floating-point values or booleans (represented as 0- or 1-valued
  223. integers).  Each of the procedures takes a \fIstring\fR argument,
  224. converts it to an internal form of a particular type, and stores
  225. the converted value at the location indicated by the procedure's
  226. third argument.  If all goes well, each of the procedures returns
  227. TCL_OK.  If \fIstring\fR doesn't have the proper syntax for the
  228. desired type then TCL_ERROR is returned, an error message is left
  229. in \fIinterp->result\fR, and nothing is stored at *\fIintPtr\fR
  230. or *\fIdoublePtr\fR or *\fIboolPtr\fR.
  231. .PP
  232. \fBTcl_GetInt\fR expects \fIstring\fR to consist of a collection
  233. of integer digits, optionally signed and optionally preceded by
  234. white space.  If the first two characters of \fIstring\fR are ``0x''
  235. then \fIstring\fR is expected to be in hexadecimal form;  otherwise,
  236. if the first character of \fIstring\fR is ``0'' then \fIstring\fR
  237. is expected to be in octal form;  otherwise, \fIstring\fR is
  238. expected to be in decimal form.
  239. .PP
  240. \fBTcl_GetDouble\fR expects \fIstring\fR to consist of a floating-point
  241. number, which is:  white space;  a sign; a sequence of digits;  a
  242. decimal point;  a sequence of digits;  the letter ``e'';  and a
  243. signed decimal exponent.  Any of the fields may be omitted, except that
  244. the digits either before or after the decimal point must be present
  245. and if the ``e'' is present then it must be followed by the
  246. exponent number.
  247. .PP
  248. \fBTcl_GetBoolean\fR expects \fIstring\fR to specify a boolean
  249. value.  If \fIstring\fR is any of \fB0\fR, \fBfalse\fR,
  250. .VS
  251. \fBno\fR, or \fBoff\fR, then \fBTcl_GetBoolean\fR stores a zero
  252. value at \fI*boolPtr\fR.
  253. If \fIstring\fR is any of \fB1\fR, \fBtrue\fR, \fByes\fR, or \fBon\fR,
  254. .VE
  255. then 1 is stored at \fI*boolPtr\fR.
  256. Any of these values may be abbreviated, and upper-case spellings
  257. are also acceptable.
  258.  
  259. .SH KEYWORDS
  260. boolean, conversion, double, floating-point, integer
  261.